SfincsConfigModel

config.SfincsConfigModel()

The expected variables and data types of attributes of the SfincsConfig class.

Attributes

csname : str

The name of the CS model.

cstype : Cstype

Cstype of the CS model. must be either “projected” or “spherical”.

version : Optional[str], default = None

The version of the CS model. If None, the version is not specified.

offshore_model : Optional[FloodModel], default = None

The offshore model. If None, the offshore model is not specified.

overland_model : FloodModel

The overland model. This is the main model used for the simulation.

floodmap_units : us.UnitTypesLength

The units used for the output floodmap. Sfincs always produces in metric units, this is used to convert the floodmap to the correct units.

save_simulation : Optional[bool], default = False

Whether to keep or delete the simulation files after the simulation is finished and all output files are created. If True, the simulation files are kept. If False, the simulation files are deleted.

Back to top